Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(docs): autogenerate framework docs #1588

Merged
merged 18 commits into from
Aug 19, 2024
Merged

Conversation

Dr-Electron
Copy link
Contributor

Description of change

I merged everything from the docusaurus plugin into the build script to have all needed changes in once place and let the build script output the docs directly to docusaurus. That way the docs will be autogenerated on demand.

Links to any relevant issues

Fixes #1035.

Type of change

  • Documentation Enhancement

How the change has been tested

Tested locally

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

@Dr-Electron Dr-Electron requested review from a team as code owners August 2, 2024 11:57
Copy link
Contributor

github-actions bot commented Aug 3, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Aug 3, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@Dr-Electron
Copy link
Contributor Author

Dr-Electron commented Aug 3, 2024

Until the latest commit all this changes where basically visually identical to what SUI did. But the latest commit enables code blocks again. SUI says they had problems with code blocks, but I'm not sure why. I prefer code blocks in some places to highlight a word. So I removed their code and added some to fix the resulting issues with code tags and MDX. If someone sees any weird results in code blocks from that, just report it. We can add back their "fix" anytime

Copy link
Contributor

github-actions bot commented Aug 3, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@DaughterOfMars
Copy link
Contributor

Are all the docs supposed to be deleted now?

@Dr-Electron
Copy link
Contributor Author

Are all the docs supposed to be deleted now?

I would say so, yes. I hate autogenerated docs that are checked in. But we can discuss it, if anyone has strong arguments to keep them

Copy link
Member

@samuel-rufi samuel-rufi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@DaughterOfMars
Copy link
Contributor

rustfmt is failing

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

@miker83z miker83z left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@Dr-Electron Dr-Electron merged commit 9a386ef into develop Aug 19, 2024
33 of 36 checks passed
@Dr-Electron Dr-Electron deleted the devx/automate-docs-gen branch August 19, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task (SC-Platform)]: Auto-generated docs should not be pushed to the repository
7 participants